revelplayer/com.reveldigital.player.api/[androidJvm]Beacon

Beacon

interface Beacon

Represents a beacon device and the context of a beacon-related event.

This interface provides access to various properties of a beacon, such as its identifiers, measured signal strength, and estimated distance, as well as details specific to a beacon event, like the event type (enter/exit) and timestamp.

Implementations of this interface are typically associated with events triggered when a user's device enters or exits the activation area of a physical beacon.

See also

Properties

Link copied to clipboard
val EVENT_TYPE_ENTER: Int = 16
Represents an "enter" event for a beacon region.
Link copied to clipboard
val EVENT_TYPE_EXIT: Int = 32
Represents an "exit" event for a beacon region.

Functions

Link copied to clipboard
abstract fun getBluetoothName(): String
Gets the Bluetooth device name of the beacon, as broadcasted, if available.
Link copied to clipboard
abstract fun getDeviceId(): Int
Gets the identifier of the physical beacon device that triggered this event.
Link copied to clipboard
abstract fun getDistance(): Double
Gets an estimated distance to the beacon in meters.
Link copied to clipboard
abstract fun getDwell(): Long
Gets the duration, in milliseconds, for which the user's device remained within the beacon's range before this event was triggered.
Link copied to clipboard
abstract fun getId(): Int
Gets the unique identifier for this specific beacon ping or event instance.
Link copied to clipboard
abstract fun getId1(): String
Gets the first identifier of the beacon.
Link copied to clipboard
abstract fun getId2(): String
Gets the second identifier of the beacon.
Link copied to clipboard
abstract fun getId3(): String
Gets the third identifier of the beacon.
Link copied to clipboard
abstract fun getLatitude(): Double
Gets the geographical latitude associated with this beacon's configured location, if available.
Link copied to clipboard
abstract fun getLongitude(): Double
Gets the geographical longitude associated with this beacon's configured location, if available.
Link copied to clipboard
abstract fun getMacAddress(): String
Gets the MAC address of the Bluetooth Low Energy (BLE) device acting as the beacon, if available.
Link copied to clipboard
abstract fun getManufacturer(): Int
Gets a two-byte code indicating the manufacturer of the beacon hardware.
Link copied to clipboard
abstract fun getPingType(): Int
Gets the type of beacon event.
Link copied to clipboard
abstract fun getRssi(): Int
Gets the Received Signal Strength Indicator (RSSI) of the Bluetooth packet from the beacon.
Link copied to clipboard
abstract fun getTimestamp(): Date
Gets the exact date and time when this beacon event occurred.
Link copied to clipboard
abstract fun getTxPower(): Int
Gets the calibrated transmission power of the beacon in RSSI.
Link copied to clipboard
abstract fun getUser(): BeaconUser
Gets the user profile associated with this beacon event, if any.